home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr46 / manual11.zip / README.1ST < prev    next >
Text File  |  1993-05-04  |  12KB  |  338 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.           -------------------------------------------------------------------
  22.                           SUPERMANual - User Manual Creator                
  23.           -------------------------------------------------------------------
  24.  
  25.                                  Copyright (c) 1993                        
  26.                                  Auto-Jock Software                        
  27.  
  28.  
  29.                                  Eighteen 8th Street                       
  30.                                  Wheeling, WV  26003                       
  31.                                    (304) 232-1773                          
  32.                         T a b l e   o f   C o n t e n t s                        
  33.           -------------------------------------------------------------------
  34.  
  35.           WHY SUPERMANUAL.............................................1
  36.           USAGE - COMMAND LINE PARAMETERS.............................2
  37.                 CONFIGURING SUPERMANUAL /C............................2
  38.                 SUPERMANUAL VERSION /V................................3
  39.                 SUPERMANUAL CREATE ...................................3
  40.  
  41.           SUPERMANual - Users Manual Creator                          Pg. 1
  42.           -------------------------------------------------------------------
  43.  
  44.           WHY SUPERMANUAL
  45.           ---------------
  46.  
  47.           SUPERMANual v.1.1 (5/3/93) - Is a Source Code util that creates
  48.           a complete Users Manual for editing with a word processor or
  49.           printing direct.
  50.           
  51.           You place a special header file in your source and maintain all
  52.           text info for the manual in your source code.  SUPERMANual will
  53.           extract and assemble your users manual for you.
  54.           
  55.           This Manual was completely created with SUPERMANual.  If you
  56.           would like to have an instant Users Manual, this is the program
  57.           for you.
  58.           
  59.           If you are using the DEMO version, of SUPERMANual, you can print
  60.           up to a 6 page manual with Cover Page, Table of Contents, Index,
  61.           Header, Footer, Page Numbers and the 6 page manual.
  62.           
  63.           You can register this program online on our support BBS by
  64.           calling 609-383-9400 14.4Kb 24 Hours, 9 Nodes.
  65.           
  66.           Please Join Conference 8 - The Auto-Jock Conference        
  67.           
  68.           Thank you for using SUPERMANual.  Written By Jim Barcus.
  69.           
  70.           You can get support by calling 304-232-1773 noon to 7pm EST.
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.           -------------------------------------------------------------------
  100.           (c)1993 A-J Software  Version 1.1                           
  101.           SUPERMANual - Users Manual Creator                          Pg. 2
  102.           -------------------------------------------------------------------
  103.  
  104.           USAGE - COMMAND LINE PARAMETERS
  105.           -------------------------------
  106.  
  107.           Command Line Parameters
  108.           --------------------------------------------------------------
  109.           MANUAL filename.ext
  110.           
  111.           Will add the [filename] text to the current manual file.  Use
  112.           this format for each of your .prg, .c or .cpp files for your
  113.           application to the txt.dbf file.
  114.           
  115.           --------------------------------------------------------------
  116.           MANUAL filename.ext /e
  117.           
  118.           The /e switch will empty the txt.dbf file so you can start over.
  119.           
  120.           --------------------------------------------------------------
  121.           MANUAL CREATE
  122.           
  123.           Will create the finished Manual that is ready to print or ready
  124.           for your word processor.
  125.           
  126.           --------------------------------------------------------------
  127.           MANUAL /c
  128.           
  129.           To configure the manual that you are creating.
  130.           
  131.           --------------------------------------------------------------
  132.           MANUAL /v
  133.           
  134.           The SUPERMANual Version number will be displayed.
  135.           
  136.           --------------------------------------------------------------
  137.           
  138.           SUPERMANual will work with Clipper and dBase IV .prg files, .c
  139.           files and C++ files.
  140.           
  141.           Simply add the extention for the Language that you use.
  142.           
  143.           We have a special Version of SUPERMANual for FOXbase, dbase III+,
  144.           Clipper S87 and earlier version of clipper.
  145.           
  146.           When you purchase SUPERMANuals, you get both versions.
  147.  
  148.           CONFIGURING SUPERMANUAL /C
  149.           --------------------------
  150.  
  151.           When you use the /c switch, you will see the following questions.
  152.           
  153.           Enter the complete Program Name.
  154.  
  155.  
  156.  
  157.           -------------------------------------------------------------------
  158.           (c)1993 A-J Software  Version 1.1                           
  159.           SUPERMANual - Users Manual Creator                          Pg. 3
  160.           -------------------------------------------------------------------
  161.  
  162.           Enter the copyright owner name.
  163.           Enter up to a three line description.
  164.           Header :
  165.           Footer :
  166.           
  167.           The Program Name can be up to 65 charactors long and will be
  168.           centered on your CoverPage.
  169.           
  170.           The Copyright Owner Name can be up to 50 charactors long and
  171.           will be centered on your CoverPage.
  172.           
  173.           The Header can be up to 60 charactors long and will be located
  174.           on top of each manual page.  (not CoverPage, TOC, Index)  The
  175.           Header will also print the page # automatically.
  176.           
  177.           The Footer can be up to 60 charactors long and will be located
  178.           at the bottom of each manual page.  (not CoverPage, TOC, Index)
  179.           
  180.           
  181.           You can also place a 3 line decription of your program on the
  182.           front cover of the manual.  These lines are all centered.
  183.  
  184.           SUPERMANUAL VERSION /V
  185.           ----------------------
  186.  
  187.           When you use the /v switch, you will see a screen that shows you
  188.           the current version of SUPERMANual that you are using.
  189.           
  190.           It will also show you the date version and our address and
  191.           phone numbers.
  192.  
  193.           ADDING THE COMMENT BLOCK TO YOUR SOURCE CODE
  194.           --------------------------------------------
  195.  
  196.           At every point in your program where you would like to add some
  197.           users manual text, you will have to add a comment block that look
  198.           like this:
  199.           
  200.           $SUPERMAN$
  201.           $CHAPTER$
  202.           
  203.           $SUBCHAPTER$
  204.           
  205.           $HEADING$
  206.           
  207.           $INDEXWORDS$
  208.           
  209.           $TXT$
  210.           
  211.           $END$
  212.           
  213.  
  214.  
  215.  
  216.           -------------------------------------------------------------------
  217.           (c)1993 A-J Software  Version 1.1                           
  218.           SUPERMANual - Users Manual Creator                          Pg. 4
  219.           -------------------------------------------------------------------
  220.  
  221.           The comment block is left justified and the spelling of the
  222.           words must be exactly as shown above.
  223.           
  224.           $SUPERMAN$ - This tells SUPERMANual that it has found a
  225.           manual section and not just a normal program comment. This
  226.           MUST be the first line in the comment block.
  227.           
  228.           ----------------------------------------------------------------
  229.           
  230.           $CHAPTER$ - This tells SUPERMANual what level to attach this
  231.           section of the manual to.
  232.           
  233.           The word $CHAPTER$ MUST be under the $SUPERMAN$ word and
  234.           left.  Directly under the $CHAPTER$ word MUST be the
  235.           Chapter Number.  This is a whole number and up to 2 digits
  236.           wide.
  237.           
  238.           ----------------------------------------------------------------
  239.           
  240.           $SUBCHAPTER$ - This tells SUPERMANual what Sub-level in the
  241.           current chapter to attach this section of the manual to.
  242.           
  243.           The word $SUBCHAPTER$ MUST be under the chapter number and
  244.           left.  Directly under the $SUBCHAPTER$ word MUST be the
  245.           Sub-Chapter Number.  This is a whole number and up to 3
  246.           digits wide.  This is the order in which this sub-chapter
  247.           falls in this chapter.
  248.           
  249.           ----------------------------------------------------------------
  250.           
  251.           $HEADING$ - This tells SUPERMANual what the Name of this
  252.           level is.
  253.           
  254.           The word $HEADING$ MUST be under the sub-chapter number and
  255.           left.  Directly under the $HEADING$ word MUST be the
  256.           Heading Name.  This is a charactor string up to 65 wide.
  257.           
  258.           ----------------------------------------------------------------
  259.           $INDEXWORDS$ - This tells SUPERMANual that some Index Page
  260.           Keywords are to follow.  This is not requiered.
  261.           
  262.           If you wish to include keywords, the word $INDEXWORDS$ MUST
  263.           be under the Heading Name and Left.  Directly under the
  264.           $INDEXWORDS$ word MUST be the list of keywords. One Keyword
  265.           per line and up to 20 chrs per keyword.
  266.           
  267.           $TXT$ - This tells SUPERMANual that this is the manual text.
  268.           
  269.           Up to 65 chrs per line and an unlimited number of lines long.
  270.           
  271.           $END$ - This tells SUPERMANual that this is the end of the
  272.  
  273.  
  274.  
  275.           -------------------------------------------------------------------
  276.           (c)1993 A-J Software  Version 1.1                           
  277.           SUPERMANual - Users Manual Creator                          Pg. 5
  278.           -------------------------------------------------------------------
  279.  
  280.           manual text.
  281.           
  282.  
  283.           READING YOUR SOURCE CODE
  284.           ------------------------
  285.  
  286.           After you have run MANual /c to configure your manual and
  287.           you have added all of the comment blocks to your files, you will
  288.           be ready to start reading your files into SUPERMANual.
  289.           
  290.           This step is very easy.  Simply type:
  291.           
  292.           MANUAL yourfile.ext [enter]
  293.           
  294.           The Databases that SUPERMANual uses will be created the first
  295.           time you use this program.
  296.           
  297.           If you should happen to read in the same file twice or make a
  298.           last minute change, you can use the /e switch after the file-
  299.           name.
  300.           
  301.           IE:  MANUAL yourfile.ext /e [enter]
  302.           
  303.           This will allow you to start over from the first source file.
  304.           
  305.           Just use this for adding each of your source files.  This will
  306.           not take too long at all.
  307.  
  308.           SUPERMANUAL CREATE
  309.           ------------------
  310.  
  311.           After you have run SUPERMANual on each of your commented source
  312.           code files, you can go to this final step.
  313.           
  314.           You will end up with 4 ASCII files.  The files are:
  315.           
  316.           COVRPAGE.DOC
  317.           
  318.           This is the cover page for your manual.
  319.           
  320.           TOC.DOC
  321.           
  322.           This is your Table of contents that goes just after the cover
  323.           page in the front of the manual.
  324.           
  325.           MANUAL.DOC
  326.           
  327.           This is the actual Users Manual.  This is normally the largest
  328.           file of the 4 files created.  If this is a DEMO version of
  329.           SUPERMANual, it will be 6 pages MAX.
  330.           
  331.  
  332.  
  333.  
  334.           -------------------------------------------------------------------
  335.           (c)1993 A-J Software  Version 1.1                           
  336.  
  337.  
  338.